/*
 * Copyright 2011 Clean GWT
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package com.cleangwt.uibinder.client;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Marks fields in a {@link RequiresTemplate} or {@link RequiresWebTemplate} owner, each field must
 * be created and wraps a element of template by the binder's {@link #createTemplate()} method. If
 * provided is true the field creation is delegated to the client (owner). As the same, the fields
 * will replace respective elements of template.
 * 
 * @author Jess
 * @version 1.0
 * @since 1.0
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface UiField {
  /**
   * If true, the field must be filled before {@link #createTemplate()} is called. If false, {@link
   * createTemplate()} will fill the field, by calling {SomeWidget}.wrap(TemplateSupport,Element) to
   * wrap exiting element into widget.
   */
  boolean provided() default false;
}
